Skip to main content

Get Fee Card List

GET /orders/shipping/rate-cards/shipping/rate-cards/weight-band

Description

Retrieve the list of fee cards based on weight bands. This endpoint allows you to get the shipping fee rate card details.

Parameters

  • tenantId (string, header, required): The ID of the tenant.
  • countryCode (string, header, required): The country code.
  • unitOfMeasurement (string, query, required): The unit of measurement for the weight bands.
  • pageNumber (integer, query, optional): The page number for pagination (default: 1).
  • pageSize (integer, query, optional): The number of items per page for pagination (default: 10).

Responses

This section outlines the possible responses from the get fee card list API.

Success Response (200)

The Success Response (200) is returned when the fee card list is successfully retrieved. This response indicates the success of the operation and provides additional details.

Response Fields

FieldTypeDescription
statusbooleanIndicates the success of the fee card list retrieval request.
statusCodeintegerNumeric code representing the status of the response (e.g., 0 for success).
messagestringA message indicating the outcome of the operation.
dataobjectContains the retrieved fee card list details.
errorsarrayAn array of objects providing details about any errors encountered during the request.

Example

JSON:

{
"status": true,
"statusCode": 0,
"message": "retrieved successfully",
"data": {},
"errors": [
{
"message": "string",
"descriptiveMessage": "string"
}
]
}

Media Type

application/json: The response is in JSON format.

Example Value

Schema:

{
"status": true,
"statusCode": 0,
"message": "string",
"data": {},
"errors": [
{
"message": "string",
"descriptiveMessage": "string"
}
]
}

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST


curl --request GET \ 
--url /orders/shipping/rate-cards/shipping/rate-cards/weight-band \
--header 'accept: application/json' \
--header 'content-type: application/json'

RESPONSE


Click Try It! to start a request and see the response here!